<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
	<title>YUI Library Examples: Dom Collection: Exploring the Dom Collection's API</title>
    

    <meta http-equiv="content-type" content="text/html; charset=utf-8">
    	<link rel="stylesheet" type="text/css" href="../../assets/yui.css" >

<style>
/*Supplemental CSS for the YUI distribution*/
#custom-doc { width: 95%; min-width: 950px; }
#pagetitle {background-image: url(../../assets/bg_hd.gif);}
</style>

<link rel="stylesheet" type="text/css" href="../../assets/dpSyntaxHighlighter.css">
<!--Script and CSS includes for YUI dependencies on this page-->
<link rel="stylesheet" type="text/css" href="../../build/button/assets/skins/sam/button.css" />
<script type="text/javascript" src="../../build/yuiloader/yuiloader-min.js"></script>
<script type="text/javascript" src="../../build/event/event-min.js"></script>
<script type="text/javascript" src="../../build/dom/dom-min.js"></script>
<script type="text/javascript" src="../../build/element/element-min.js"></script>
<script type="text/javascript" src="../../build/button/button-min.js"></script>


<!--begin custom header content for this example-->
<style type="text/css" media="screen">

div.contentContainer {
	border: 1px solid #333;
	padding: 10px;
	margin-bottom:1em;    		
}

#source li {
	list-style-type: decimal;
	margin-left: 20px;
}
#source li.highlight {
	list-style-type: decimal;     	    
}
.highlight {
	background: #ccf;
	color: blue;
}

li.even {
	background: #b3b3b3;
}



</style>

<!--end custom header content for this example-->


<script type="text/javascript">
//enable passthrough of errors from YUI Event:
if ((typeof YAHOO !== "undefined") && (YAHOO.util) && (YAHOO.util.Event)) {
	YAHOO.util.Event.throwErrors = true;
}
</script>
</head>
<body id="yahoo-com" class="yui-skin-sam">
<div id="custom-doc" class="yui-t2">
<div id="hd">
	<div id="ygunav">
		<p><em><a href="http://developer.yahoo.com/yui/">YUI Library Home</a></em></p>
		<form action="http://search.yahoo.com/search" id="sitesearchform">
		<input name="vs" type="hidden" value="developer.yahoo.com">
		<input name="vs" type="hidden" value="yuiblog.com">
		<div id="sitesearch">
			<label for="searchinput">Site Search (YDN &amp; YUIBlog): </label>
			<input type="text" id="searchinput" name="p">
			<input type="submit" value="Search" id="searchsubmit" class="ygbt">
		</div>
		</form>	</div>
	<div id="ygma"><a href="../../"><img src="../../assets/yui.gif"  border="0" height="38"></a></div>
	<div id="pagetitle"><h1>YUI Library Examples: Dom Collection: Exploring the Dom Collection's API</h1></div>
</div>
<div id="bd">
	
	<div id="yui-main">
		<div class="yui-b">
		  <div class="yui-ge">
			  <div class="yui-u first example">

            <cite class="byline">This example was contributed by <a href='http://www.wait-till-i.com/'>Christian Heilmann</a> and members of his <a href='http://yuiblog.com/blog/2007/12/06/juku/'>Juku</a> training class at Yahoo.</cite>
    
	<div class="promo">
	<h1>Dom Collection: Exploring the Dom Collection's API</h1>
	
	<div class="exampleIntro">
	<p>In this example, the use of several key Dom Collection methods is explored.  Given the markup in the source section, you can invoke any of the methods by clicking on them; the Source is updated, as is its in-browser appearance (Render).  In the Outupt section, you can review the elements that are selected or affected (or, in a few cases, the JavaScript <code>return</code> value) of the function you invoked.</p>			
	</div>	
					
	<div class="example-container module ">
			<div class="hd exampleHd">
			<p class="newWindowButton yui-skin-sam"><!--<span id="newWindowLinkx"><span class="first-child">--><a href="dom-explorer_clean.html" target="_blank">View example in new window.</a><!--</span></span>-->		
		</div>		<div id="example-canvas" class="bd">
	
		
	<!--BEGIN SOURCE CODE FOR EXAMPLE =============================== -->
	
	<h3>Source</h3>

<div id="source" class="contentContainer">
    <pre>
    </pre>
</div>
        
<h3>Functions</h3>
<div id="functions" class="contentContainer">
    <ul id="functionList">
        <li id="get1"><a href="foo.html">get('demo')</a></li>
        <li id="get2"><a href="foo.html">get(['demo', 'demoList'])</a></li>
        <li id="getAncestorByTagName"><a href="foo.html">getAncestorByTagName('one', 'div')</a></li>
        <li id="getAncestorByClassName"><a href="foo.html">getAncestorByClassName('one', 'parent')</a></li>
        <li id="getChildren"><a href="foo.html">getChildren('demoList')</a></li>

        <li id="getElementsBy"><a href="foo.html">getElementsBy(<em>getElementsByClassName('specialItems')</em>, 'li', 'demo')</a></li>
        <li id="getFirstChild"><a href="foo.html">getFirstChild('demoList')</a></li>
        <li id="getLastChild"><a href="foo.html">getLastChild('demoList')</a></li>
        <li id="getNextSibling"><a href="foo.html">getNextSibling('one')</a></li>
        <li id="getPreviousSibling"><a href="foo.html">getPreviousSibling('two')</a></li>

        <li id="isAncestor"><a href="foo.html">isAncestor('demo', 'one')</a></li>
        <li id="insertBefore"><a href="foo.html">insertBefore(<em>li</em>, 'one')</a></li>
        <li id="insertAfter"><a href="foo.html">insertAfter(<em>li</em>, 'one')</a></li>
    </ul>
</div>

<h3>Render</h3>
<div id="render" class="contentContainer">    				
</div>

<h3>Output</h3>
<div id="output" class="contentContainer">
</div>



<script type="text/javascript" charset="utf-8">

(function() {
YAHOO.util.Event.addListener("functionList", "click", function(evt) {
	var target = YAHOO.util.Event.getTarget(evt);	
	YAHOO.util.Event.preventDefault(evt);    		
	if(evt.type === 'click' && target && target.parentNode.id) {
		setView(target.parentNode.id);
	}
});     	

// constant codedemo
var codedemo = [];
codedemo.push('<div id="demo">');
codedemo.push('  <ul id="demoList" class="parent">');    	
codedemo.push('    <li id="one" class="listItem">item 1</li>');
codedemo.push('    <li id="two" class="listItem">item 2</li>');
codedemo.push('    <li id="three" class="specialItem">item 3</li>');    	
codedemo.push('  </ul>');
codedemo.push('</div>');

// views object
var views = {
	sourceView: document.getElementById('source'),
	renderView: document.getElementById('render'),
	outputView: document.getElementById('output'),

	defaultView: {
		source: function() {
			return codedemo;
		},
		output: ['Please select a function.']
	},
	get1 : {
		source: function(){
			var temp = [].concat(codedemo);
			temp[0] = '<div id="demo" class="highlight">';
			return temp;
		},
		output: ['<div id="demo" class="highlight">']
	},
	get2 : {
		source: function(){
			var temp = [].concat(codedemo);
			temp[0] = '<div id="demo" class="highlight">';
			temp[1] = '  <ul id="demoList" class="parent highlight">';
			return temp;
		},
		output: ['<div id="demo" class="highlight">', '<ul id="demoList" class="parent highlight">']
	},
	getAncestorByTagName : {
		source: function() {
			var temp = [].concat(codedemo);
			temp[0] = '<div id="demo" class="highlight">';
			return temp;
		},
		output: ['<div id="demo" class="highlight">']
	},
	getAncestorByClassName : {
		source: function (){
				var temp = [].concat(codedemo);
				temp[1]='  <ul id="demoList" class="parent highlight">';
				return temp;
		},
		output: ['<ul id="demoList" class="parent highlight">']    
	},
	getChildren : {
	   source: function (){
		   var temp = [].concat(codedemo);
		   temp[2]='    <li id="one" class="listItem highlight">item 1</li>';
		   temp[3]='    <li id="two" class="listItem highlight">item 2</li>';
		   temp[4]='    <li id="three" class="specialItem highlight">item 3</li>';                   
		   return temp;
	   },        
	   output: ['<li id="one" class="listItem">first</li>', 
				'<li id="two" class="listItem highlight">second</li>' ,
				'<li id="three" class="specialItem highlight">item 3</li>']
   },
   getFirstChild : {
	source: function (){
		var temp =[].concat(codedemo);
		temp[2]='    <li id="one" class="listItem highlight">item 1</li>';
		return temp;
	}, 
	output: ['<li id="one" class="listItem">']
   },
   getLastChild : {
	source: function(){
		var temp =[].concat(codedemo);
		temp[4] = '    <li id="three" class="specialItem highlight">item 3</li>';
		return temp;
	},
	output : ['<li id="three" class="specialItem">']
   },
   getNextSibling : {
	 source: function(){
		var temp = [].concat(codedemo);
		temp[3]='    <li id="two" class="listItem highlight">item 2</li>';
		return temp;
	 },
	 output: ['<li id="two" class="listItem">']
   },
   getPreviousSibling : {
	 source: function(){
		var temp = [].concat(codedemo);
		temp[2]='    <li id="one" class="listItem highlight">item 1</li>';
		return temp;
	 },
	 output: ['<li id="one" class="listItem">']
   },
   isAncestor : {
	source : function(){
		var temp = [].concat(codedemo);
		temp[0] = '<div id="demo" "highlight">';
		temp[2]='    <li id="one" class="listItem highlight">item 1</li>';
		return temp;
	},
	output: ['true']
   },
   insertBefore : {
		source : function(){
		var temp = [].concat(codedemo);
		temp.splice(2,0,'    <li id="four" class ="listItem highlight">new Item</li>');
		return temp;
	},
	output: ['<li id="four">']
   },
   insertAfter: {
		source : function(){
		var temp = [].concat(codedemo);
		temp.splice(3,0,'    <li id="four" class ="listItem highlight">new Item</li>');
		return temp;
	},
	output: ['<li id="four">']
   },
   getElementsBy : {
		source: function (){
				var temp = [].concat(codedemo);
				temp[4] ='    <li id="three" class="specialItem highlight">item 3</li>';
				return temp;
		},		
		output: ['<li id="three" class="specialItem">item 3</li>']
	}
};

// render initial view
setView('defaultView');

function setView(viewName) {   
	// update sourceView
    if (views[viewName]) {
        views['sourceView'].innerHTML = renderCode(views[viewName].source());
        
        // update renderView
        var code = views[viewName].source().join('');
        code = code.replace(',', '');
        views['renderView'].innerHTML = code;   

        var output = views[viewName].output;
        views['outputView'].innerHTML = '';
        var pre = document.createElement('pre');
        for (var i = 0; output[i]; i++) {
            pre.appendChild(document.createTextNode(output[i]));
            pre.appendChild(document.createTextNode('\n'));                
            views['outputView'].appendChild(pre);
        }
    }
}


function renderCode(codedemo){
  var out = '';          
  out += '<pre><ol>';
  var hlString = '';
  
  for(var i=0;codedemo[i];i++){                          
	if (codedemo[i].search('highlight') !== -1) {
		hlString = ' class="highlight"';
	} else {
		if (i%2==0)
		hlString = ' class="even"';
	}        
	out += '<li' + hlString + '><code>'+encode(codedemo[i])+'</code></li>'
	hlString = ''
  }
  out+='</ol></pre>';
  return out;
}        
function encode(str){
  str = str.replace(/</g,'&lt;');
  str = str.replace(/>/g,'&gt;');
  str = str.replace(/"/g,'&quot;');
  return str;
}
})();   
</script>
	
	<!--END SOURCE CODE FOR EXAMPLE =============================== -->
	
		
		</div>
		
	
	</div>			
	</div>
		
	
<h2>Configuration for This Example</h2>

<p>You can load the necessary JavaScript and CSS for this example from Yahoo's servers.  <a href="http://developer.yahoo.com/yui/articles/hosting/?event&dom&MIN#configure">Click here to load the YUI Dependency Configurator with all of this example's dependencies preconfigured</a>.</p>

				</div>
				<div class="yui-u">
						<div id="loggerModule" class="yui-skin-sam">
						<h3 class="firstContent">YUI Logger Output:</h3>
								<div id="loggerGloss"><p><strong>Note:</strong> Logging and debugging is currently turned off for this example.</p> 
							<p class="loggerButton"><span id="loggerLink"><span class="first-child"><a href="dom-explorer_log.html">Reload with logging<br />
	 and debugging enabled.</a></span></span></p></div>
	
						</div>
					
				
					<div id="examples">
						<h3>Dom Collection Examples:</h3>
	
						<div id="exampleToc">
							<ul>
								<li><a href='../dom/setxy.html'>Using setXY</a></li><li><a href='../dom/getxy.html'>Using getXY</a></li><li><a href='../dom/setstyle.html'>Using setStyle</a></li><li><a href='../dom/getstyle.html'>Using getStyle</a></li><li><a href='../dom/hasclass.html'>Using hasClass</a></li><li><a href='../dom/addclass.html'>Using addClass</a></li><li><a href='../dom/removeclass.html'>Using removeClass</a></li><li><a href='../dom/getelementsbyclassname.html'>Using getElementsByClassName</a></li><li class='selected'><a href='../dom/dom-explorer.html'>Exploring the Dom Collection's API</a></li>							</ul>
						</div>
					</div>
					
					<div id="module">
						<h3>More Dom Collection Resources:</h3>
						<ul>
							<li><a href="http://developer.yahoo.com/yui/dom/">User's Guide</a> (external)</li>
						<li><a href="../../docs/module_dom.html">API Documentation</a></li>
                            
                            
							<li><a href="http://yuiblog.com/assets/pdf/cheatsheets/dom.pdf">Cheat Sheet PDF</a> (external)</li></ul>
					</div>
			  </div>
		</div>
		
		</div>
	</div>


<div class="yui-b" id="tocWrapper">
<!-- TABLE OF CONTENTS -->
<div id="toc">
	
<ul>
<li class="sect first">Yahoo! UI Library</li><li class="item"><a title="The Yahoo! User Interface Library (YUI)" href="http://developer.yahoo.com/yui/">Home (external)</a></li><li class="item"><a title="The Yahoo! User Interface Blog" href="http://yuiblog.com">YUIBlog (external)</a></li><li class="item"><a title="YUILibrary.com hosts the YUI community forums" href="http://yuilibrary.com/forum/">YUI Discussion Forum (external)</a></li><li class="item"><a title="The YUI Library source can be checked out from GitHub" href="http://github.com/yui/">YUI on GitHub</a></li><li class="item"><a title="Instantly searchable API documentation for the entire YUI library." href="../../docs/index.html">API Documentation</a></li><li class="item"><a title="Examples of every YUI utility and control in action" href="../../examples/">Functional Examples</a></li><li class="item"><a title="Videos and podcasts from the YUI Team and from the Yahoo! frontend engineering community." href="http://developer.yahoo.com/yui/theater/">YUI Theater (external)</a></li><li class="item"><a title="YUI is free and open, offered under a BSD license." href="http://developer.yahoo.com/yui/license.html">YUI License (external)</a></li><li class="sect">YUI Functional Examples</li><li class="item"><a title="The YUI Animation Utility - Functional Examples" href="../../examples/animation/index.html">Animation</a></li><li class="item"><a title="The YUI AutoComplete Control - Functional Examples" href="../../examples/autocomplete/index.html">AutoComplete</a></li><li class="item"><a title="The YUI Browser History Manager - Functional Examples" href="../../examples/history/index.html">Browser History Manager</a></li><li class="item"><a title="The YUI Button Control - Functional Examples" href="../../examples/button/index.html">Button</a></li><li class="item"><a title="The YUI Calendar Control - Functional Examples" href="../../examples/calendar/index.html">Calendar</a></li><li class="item"><a title="The YUI Carousel Control - Functional Examples" href="../../examples/carousel/index.html">Carousel</a></li><li class="item"><a title="The YUI Charts Control - Functional Examples" href="../../examples/charts/index.html">Charts</a></li><li class="item"><a title="The YUI Color Picker Control - Functional Examples" href="../../examples/colorpicker/index.html">Color Picker</a></li><li class="item"><a title="The YUI Cookie Utility - Functional Examples" href="../../examples/cookie/index.html">Cookie</a></li><li class="item"><a title="The YUI Connection Manager (AJAX) - Functional Examples" href="../../examples/connection/index.html">Connection Manager</a></li><li class="item"><a title="The YUI Container Family (Module, Overlay, Tooltip, Panel, Dialog, SimpleDialog) - Functional Examples" href="../../examples/container/index.html">Container</a></li><li class="item"><a title="The YUI DataTable Control - Functional Examples" href="../../examples/datatable/index.html">DataTable</a></li><li class="selected "><a title="The YUI Dom Collection - Functional Examples" href="../../examples/dom/index.html">Dom</a></li><li class="item"><a title="The YUI Drag &amp; Drop Utility - Functional Examples" href="../../examples/dragdrop/index.html">Drag &amp; Drop</a></li><li class="item"><a title="The YUI Event Utility - Functional Examples" href="../../examples/event/index.html">Event</a></li><li class="item"><a title="The YUI Get Utility - Functional Examples" href="../../examples/get/index.html">Get</a></li><li class="item"><a title="The YUI ImageCropper Control - Functional Examples" href="../../examples/imagecropper/index.html">ImageCropper</a></li><li class="item"><a title="The YUI ImageLoader Utility - Functional Examples" href="../../examples/imageloader/index.html">ImageLoader</a></li><li class="item"><a title="The YUI JSON Utility - Functional Examples" href="../../examples/json/index.html">JSON</a></li><li class="item"><a title="The YUI Layout Manager - Functional Examples" href="../../examples/layout/index.html">Layout Manager</a></li><li class="item"><a title="The YUI Logger Control - Functional Examples" href="../../examples/logger/index.html">Logger</a></li><li class="item"><a title="The YUI Menu Control - Functional Examples" href="../../examples/menu/index.html">Menu</a></li><li class="item"><a title="The YUI Paginator - Functional Examples" href="../../examples/paginator/index.html">Paginator</a></li><li class="item"><a title="The YUI Profiler Utility - Functional Examples" href="../../examples/profiler/index.html">Profiler</a></li><li class="item"><a title="The YUI ProfileViewer Control - Functional Examples" href="../../examples/profilerviewer/index.html">ProfilerViewer</a></li><li class="item"><a title="The YUI ProgressBar Control - Functional Examples" href="../../examples/progressbar/index.html">ProgressBar</a></li><li class="item"><a title="The YUI Resize Utility - Functional Examples" href="../../examples/resize/index.html">Resize</a></li><li class="item"><a title="The YUI Rich Text Editor - Functional Examples" href="../../examples/editor/index.html">Rich Text Editor</a></li><li class="item"><a title="The YUI Selector Utility - Functional Examples" href="../../examples/selector/index.html">Selector</a></li><li class="item"><a title="The YUI Slider Control - Functional Examples" href="../../examples/slider/index.html">Slider</a></li><li class="item"><a title="The YUI Storage Utility - Functional Examples" href="../../examples/storage/index.html">Storage</a></li><li class="item"><a title="The YUI SWF Utility - Functional Examples" href="../../examples/swf/index.html">SWF</a></li><li class="item"><a title="The YUI SWFStore Utility - Functional Examples" href="../../examples/swfstore/index.html">SWFStore</a></li><li class="item"><a title="The YUI Stylesheet Utility - Functional Examples" href="../../examples/stylesheet/index.html">Stylesheet</a></li><li class="item"><a title="The YUI TabView Control - Functional Examples" href="../../examples/tabview/index.html">TabView</a></li><li class="item"><a title="The YUI TreeView Control - Functional Examples" href="../../examples/treeview/index.html">TreeView</a></li><li class="item"><a title="The YUI Uploader Utility - Functional Examples" href="../../examples/uploader/index.html">Uploader (experimental)</a></li><li class="item"><a title="The YUI YAHOO Global Object - Functional Examples" href="../../examples/yahoo/index.html">YAHOO Global Object</a></li><li class="item"><a title="The YUI Loader Utility - Functional Examples" href="../../examples/yuiloader/index.html">YUI Loader</a></li><li class="item"><a title="The YUI Test Utility - Functional Examples" href="../../examples/yuitest/index.html">YUI Test</a></li><li class="item"><a title="YUI Reset CSS - Functional Examples" href="../../examples/reset/index.html">Reset CSS</a></li><li class="item"><a title="YUI Base CSS - Functional Examples" href="../../examples/base/index.html">Base CSS</a></li><li class="item"><a title="YUI Fonts CSS - Functional Examples" href="../../examples/fonts/index.html">Fonts CSS</a></li><li class="item"><a title="YUI Grids CSS - Functional Examples" href="../../examples/grids/index.html">Grids CSS</a></li><li class="sect">YUI Articles on the YUI Website</li><li class="item"><a title="Answers to Frequently Asked Questions about the YUI Library" href="http://developer.yahoo.com/yui/articles/faq/">YUI FAQ (external)</a></li><li class="item"><a title="Yahoo!'s philosophy of Graded Browser Support" href="http://developer.yahoo.com/yui/articles/gbs/">Graded Browser Support (external)</a></li><li class="item"><a title="Reporting Bugs and Making Feature Requests for YUI Components" href="http://developer.yahoo.com/yui/articles/reportingbugs/">Bug Reports/Feature Requests (external)</a></li><li class="item"><a title="Serve YUI source files from Yahoo! -- free, fast, and simple" href="http://developer.yahoo.com/yui/articles/hosting/">Serving YUI Files from Yahoo! (external)</a></li><li class="item"><a title="Best practices for working with web services while protecting user privacy" href="http://developer.yahoo.com/security/">Security Best Practices (external)</a></li></ul>
</div>
</div>
	</div><!--closes bd-->

	<div id="ft">
        <p class="first">Copyright &copy; 2011 Yahoo! Inc. All rights reserved.</p>
        <p><a href="http://privacy.yahoo.com/privacy/us/devel/index.html">Privacy Policy</a> - 
            <a href="http://docs.yahoo.com/info/terms/">Terms of Service</a> - 
            <a href="http://docs.yahoo.com/info/copyright/copyright.html">Copyright Policy</a> - 
            <a href="http://careers.yahoo.com/">Job Openings</a></p>
	</div>
</div>
<script src="../../assets/syntax.js"></script>
<script src="../../assets/dpSyntaxHighlighter.js"></script>
<script language="javascript"> 
dp.SyntaxHighlighter.HighlightAll('code'); 
</script>

<script src='../../assets/YUIexamples.js'></script>


</body>
</html>
